Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(compiler): descriptions in generated JSON schemas #7190

Merged
merged 9 commits into from
Oct 8, 2024
Merged

feat(compiler): descriptions in generated JSON schemas #7190

merged 9 commits into from
Oct 8, 2024
+913 −88

Conversation

Chriscbr
Copy link
Contributor

@Chriscbr Chriscbr commented Oct 1, 2024

Adds docstring information to generated JSON schemas.

Checklist

  • Title matches Winglang's style guide
  • Description explains motivation and solution
  • Tests added (always)
  • Docs updated (only required for features)
  • Added pr/e2e-full label if this feature requires end-to-end testing

By submitting this pull request, I confirm that my contribution is made under the terms of the Wing Cloud Contribution License.

@Chriscbr Chriscbr requested a review from a team as a code owner October 1, 2024 16:41
@Chriscbr Chriscbr requested a review from eladb October 1, 2024 16:41
@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 1, 2024

Thanks for opening this pull request! 🎉
Please consult the contributing guidelines for details on how to contribute to this project.
If you need any assistance, don't hesitate to ping the relevant owner over Discord.

Topic Owner
Wing SDK and standard library @chriscbr
Wing Console @skyrpex
Wing compiler and language design @chriscbr
VSCode extension and language server @chriscbr
Wing CLI @chriscbr
Documentation @boyney123
Examples @boyney123
Wing Playground @skyrpex

@monadabot
Copy link
Contributor

monadabot commented Oct 1, 2024 •
edited
Loading

Console preview environment is available at https://wing-console-pr-7190.fly.dev 🚀

Last Updated (UTC) 2024-10-08 00:13

@monadabot
Copy link
Contributor

monadabot commented Oct 1, 2024 •
edited
Loading

Benchmarks

Comparison to Baseline ⬜🟥⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜
Benchmark Before After Change
version 56ms±0.8 55ms±0.48 -1ms (-1.86%)⬜
hello_world.test.w -t sim 413ms±4.32 430ms±38.3 +17ms (+4.21%)🟥
hello_world.test.w -t tf-aws 1507ms±12.27 1505ms±9.16 -2ms (-0.15%)⬜
jsii_small.test.w -t sim 387ms±6.39 384ms±8.61 -3ms (-0.77%)⬜
jsii_small.test.w -t tf-aws 611ms±4.03 603ms±3.71 -7ms (-1.2%)⬜
jsii_big.test.w -t sim 2978ms±13.08 2980ms±6.75 +2ms (+0.07%)⬜
jsii_big.test.w -t tf-aws 3187ms±13.35 3188ms±15.42 +2ms (+0.05%)⬜
empty.test.w -t sim 375ms±3.5 372ms±3.06 -3ms (-0.81%)⬜
empty.test.w -t tf-aws 603ms±3.44 599ms±3.84 -4ms (-0.63%)⬜
functions_10.test.w -t sim 482ms±17.1 495ms±10.94 +12ms (+2.5%)⬜
functions_10.test.w -t tf-aws 2161ms±18.9 2180ms±10.56 +20ms (+0.92%)⬜
functions_1.test.w -t sim 411ms±3.85 404ms±4.1 -7ms (-1.72%)⬜
functions_1.test.w -t tf-aws 849ms±6.11 842ms±3.39 -7ms (-0.82%)⬜

⬜ Within 1.5 standard deviations
🟩 Faster, Above 1.5 standard deviations
🟥 Slower, Above 1.5 standard deviations

Benchmarks may vary outside of normal expectations, especially when running in GitHub Actions CI.

Results
name mean min max moe sd
version 55ms 55ms 56ms 0ms 1ms
hello_world.test.w -t sim 430ms 396ms 574ms 38ms 54ms
hello_world.test.w -t tf-aws 1505ms 1489ms 1526ms 9ms 13ms
jsii_small.test.w -t sim 384ms 373ms 414ms 9ms 12ms
jsii_small.test.w -t tf-aws 603ms 597ms 611ms 4ms 5ms
jsii_big.test.w -t sim 2980ms 2966ms 2999ms 7ms 9ms
jsii_big.test.w -t tf-aws 3188ms 3156ms 3238ms 15ms 22ms
empty.test.w -t sim 372ms 362ms 377ms 3ms 4ms
empty.test.w -t tf-aws 599ms 591ms 607ms 4ms 5ms
functions_10.test.w -t sim 495ms 474ms 509ms 11ms 15ms
functions_10.test.w -t tf-aws 2180ms 2158ms 2203ms 11ms 15ms
functions_1.test.w -t sim 404ms 395ms 413ms 4ms 6ms
functions_1.test.w -t tf-aws 842ms 835ms 848ms 3ms 5ms
Last Updated (UTC) 2024-10-02 16:55

@monadabot
chore: self mutation (e2e-1of2.diff)
6d87c16 
Signed-off-by: monada-bot[bot] <monabot@monada.co>
@monadabot
chore: self mutation (e2e-2of2.diff)
fd34d03 
Signed-off-by: monada-bot[bot] <monabot@monada.co>
@monadabot monadabot added the ⚠️ pr/review-mutation PR has been mutated and will not auto-merge. Clear this label if the changes look good! label Oct 1, 2024
@Chriscbr Chriscbr removed the ⚠️ pr/review-mutation PR has been mutated and will not auto-merge. Clear this label if the changes look good! label Oct 1, 2024
@Chriscbr Chriscbr merged commit a9a35a6 into main Oct 8, 2024
13 checks passed
@Chriscbr Chriscbr deleted the rybickic/struct-docs branch October 8, 2024 00:19
@monadabot
Copy link
Contributor

Congrats! 🚀 This was released in Wing 0.85.21.

@Chriscbr Chriscbr mentioned this pull request Oct 10, 2024
Merged
5 tasks
mergify bot pushed a commit that referenced this pull request Oct 10, 2024
@Chriscbr
fix(compiler): unexpected identifier 'description' (#7194)
181738d 
Fixes a bug with how we generate properties, a regression from #7190

## Checklist

- [x] Title matches [Winglang's style guide](https://www.winglang.io/contributing/start-here/pull_requests#how-are-pull-request-titles-formatted)
- [x] Description explains motivation and solution
- [x] Tests added (always)
- [ ] Docs updated (only required for features)
- [ ] Added `pr/e2e-full` label if this feature requires end-to-end testing

*By submitting this pull request, I confirm that my contribution is made under the terms of the [Wing Cloud Contribution License](https://github.com/winglang/wing/blob/main/CONTRIBUTION_LICENSE.md)*.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eladb eladb eladb left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Chriscbr @monadabot @eladb